Release 10.1A: OpenEdge Development:
Web Services

Client interface methods for SubAppObjects and ProcObjects (session-managed and session-free)

You use the methods for ProcObjects and SubAppObjects in the same way regardless of the session model. The value for the ProcObjectID element or SubAppObjectID element that you send in the SOAP request header for methods invoked on each object is initially returned in the SOAP response header of the CreatePO_ProcObject method or CreateAO_SubAppObject method that you called to instantiate the object.

ProcObject methods

A ProcObject provides the following methods.

Use this method to terminate and remove the context of the persistent procedure that is managed by the ProcObject:

Release_ProcObject ( )

Once this method is executed, no other methods on the ProcObject can be called. The SOAP request header must contain the value of the ProcObjectID element. If other objects (AppObject or SubAppObjects) are sharing the same connection, the connection does not terminate until you call the release method for all the objects sharing the connection.

Call a ProcName method on the ProcObject to execute a corresponding internal procedure in the persistent procedure that is managed by the ProcObject:

ProcName (...)

The SOAP request header must contain the value of the ProcObjectID element.

Call a FuncName method on the ProcObject to execute a corresponding user-defined function in the persistent procedure that is managed by the ProcObject:

FuncName (...)

The SOAP request header must contain the value of the ProcObjectID element.

SubAppObject methods

A SubAppObject provides the following methods.

Use this method to release a SubAppObject:

Release_SubAppObject ( )

Once this method is executed, no other methods on the SubAppObject can be called. The SOAP request header must contain the value of the SubAppObjectID element. If other objects (AppObject or ProcObjects) are sharing the same connection, the connection does not terminate until you call the release method for all the objects sharing the connection.

Use this method to create a ProcObject and call the corresponding persistent procedure:

CreatePO_ProcObject (...)

This method must be executed before calling any other methods on the ProcObject. The SOAP request header must contain the value of the SubAppObjectID element. The SOAP response header returned by this method contains a ProcObjectID element whose value must be sent in the SOAP request header for all methods invoked on this ProcObject.

Call a ProcName method on the SubAppObject to execute a corresponding non-persistent external procedure typically identified by ProcName:

ProcName (...)

The SOAP request header must contain the value of the SubAppObjectID element.